home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / include / libpurple / connection.h < prev    next >
Encoding:
C/C++ Source or Header  |  2007-05-04  |  10.2 KB  |  337 lines
  1. /**
  2.  * @file connection.h Connection API
  3.  * @ingroup core
  4.  *
  5.  * purple
  6.  *
  7.  * Purple is the legal property of its developers, whose names are too numerous
  8.  * to list here.  Please refer to the COPYRIGHT file distributed with this
  9.  * source distribution.
  10.  *
  11.  * This program is free software; you can redistribute it and/or modify
  12.  * it under the terms of the GNU General Public License as published by
  13.  * the Free Software Foundation; either version 2 of the License, or
  14.  * (at your option) any later version.
  15.  *
  16.  * This program is distributed in the hope that it will be useful,
  17.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19.  * GNU General Public License for more details.
  20.  *
  21.  * You should have received a copy of the GNU General Public License
  22.  * along with this program; if not, write to the Free Software
  23.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24.  *
  25.  * @see @ref connection-signals
  26.  */
  27. #ifndef _PURPLE_CONNECTION_H_
  28. #define _PURPLE_CONNECTION_H_
  29.  
  30. typedef struct _PurpleConnection PurpleConnection;
  31.  
  32. /**
  33.  * Flags to change behavior of the client for a given connection.
  34.  */
  35. typedef enum
  36. {
  37.     PURPLE_CONNECTION_HTML       = 0x0001, /**< Connection sends/receives in 'HTML'. */
  38.     PURPLE_CONNECTION_NO_BGCOLOR = 0x0002, /**< Connection does not send/receive
  39.                                background colors.                  */
  40.     PURPLE_CONNECTION_AUTO_RESP  = 0x0004,  /**< Send auto responses when away.       */
  41.     PURPLE_CONNECTION_FORMATTING_WBFO = 0x0008, /**< The text buffer must be formatted as a whole */
  42.     PURPLE_CONNECTION_NO_NEWLINES = 0x0010, /**< No new lines are allowed in outgoing messages */
  43.     PURPLE_CONNECTION_NO_FONTSIZE = 0x0020, /**< Connection does not send/receive font sizes */
  44.     PURPLE_CONNECTION_NO_URLDESC = 0x0040,  /**< Connection does not support descriptions with links */ 
  45.     PURPLE_CONNECTION_NO_IMAGES = 0x0080,  /**< Connection does not support sending of images */
  46.  
  47. } PurpleConnectionFlags;
  48.  
  49. typedef enum
  50. {
  51.     PURPLE_DISCONNECTED = 0, /**< Disconnected. */
  52.     PURPLE_CONNECTED,        /**< Connected.    */
  53.     PURPLE_CONNECTING        /**< Connecting.   */
  54.  
  55. } PurpleConnectionState;
  56.  
  57. #include <time.h>
  58.  
  59. #include "account.h"
  60. #include "plugin.h"
  61. #include "status.h"
  62.  
  63. typedef struct
  64. {
  65.     void (*connect_progress)(PurpleConnection *gc, const char *text,
  66.                              size_t step, size_t step_count);
  67.     void (*connected)(PurpleConnection *gc);
  68.     void (*disconnected)(PurpleConnection *gc);
  69.     void (*notice)(PurpleConnection *gc, const char *text);
  70.     void (*report_disconnect)(PurpleConnection *gc, const char *text);
  71.     void (*network_connected)();
  72.     void (*network_disconnected)();
  73.  
  74.     void (*_purple_reserved1)(void);
  75.     void (*_purple_reserved2)(void);
  76.     void (*_purple_reserved3)(void);
  77.     void (*_purple_reserved4)(void);
  78. } PurpleConnectionUiOps;
  79.  
  80. struct _PurpleConnection
  81. {
  82.     PurplePlugin *prpl;            /**< The protocol plugin.               */
  83.     PurpleConnectionFlags flags;   /**< Connection flags.                  */
  84.  
  85.     PurpleConnectionState state;   /**< The connection state.              */
  86.  
  87.     PurpleAccount *account;        /**< The account being connected to.    */
  88.     char *password;              /**< The password used.                 */
  89.     int inpa;                    /**< The input watcher.                 */
  90.  
  91.     GSList *buddy_chats;         /**< A list of active chats.            */
  92.     void *proto_data;            /**< Protocol-specific data.            */
  93.  
  94.     char *display_name;          /**< How you appear to other people.    */
  95.     guint keepalive;             /**< Keep-alive.                        */
  96.  
  97.  
  98.     gboolean wants_to_die;         /**< Wants to Die state.  This is set
  99.                                       when the user chooses to log out,
  100.                                       or when the protocol is
  101.                                       disconnected and should not be
  102.                                       automatically reconnected
  103.                                       (incorrect password, etc.)         */
  104.     guint disconnect_timeout;    /**< Timer used for nasty stack tricks  */
  105. };
  106.  
  107. #ifdef __cplusplus
  108. extern "C" {
  109. #endif
  110.  
  111. /**************************************************************************/
  112. /** @name Connection API                                                  */
  113. /**************************************************************************/
  114. /*@{*/
  115.  
  116. /**
  117.  * This function should only be called by purple_account_connect()
  118.  * in account.c.  If you're trying to sign on an account, use that
  119.  * function instead.
  120.  *
  121.  * Creates a connection to the specified account and either connects
  122.  * or attempts to register a new account.  If you are logging in,
  123.  * the connection uses the current active status for this account.
  124.  * So if you want to sign on as "away," for example, you need to
  125.  * have called purple_account_set_status(account, "away").
  126.  * (And this will call purple_account_connect() automatically).
  127.  *
  128.  * @param account  The account the connection should be connecting to.
  129.  * @param regist   Whether we are registering a new account or just
  130.  *                 trying to do a normal signon.
  131.  * @param password The password to use.
  132.  */
  133. void purple_connection_new(PurpleAccount *account, gboolean regist,
  134.                                     const char *password);
  135.  
  136. /**
  137.  * Disconnects and destroys a PurpleConnection.
  138.  *
  139.  * This function should only be called by purple_account_disconnect()
  140.  * in account.c.  If you're trying to sign off an account, use that
  141.  * function instead.
  142.  *
  143.  * @param gc The purple connection to destroy.
  144.  */
  145. void purple_connection_destroy(PurpleConnection *gc);
  146.  
  147. /**
  148.  * Sets the connection state.  PRPLs should call this and pass in
  149.  * the state "PURPLE_CONNECTED" when the account is completely
  150.  * signed on.  What does it mean to be completely signed on?  If
  151.  * the core can call prpl->set_status, and it successfully changes
  152.  * your status, then the account is online.
  153.  *
  154.  * @param gc    The connection.
  155.  * @param state The connection state.
  156.  */
  157. void purple_connection_set_state(PurpleConnection *gc, PurpleConnectionState state);
  158.  
  159. /**
  160.  * Sets the connection's account.
  161.  *
  162.  * @param gc      The connection.
  163.  * @param account The account.
  164.  */
  165. void purple_connection_set_account(PurpleConnection *gc, PurpleAccount *account);
  166.  
  167. /**
  168.  * Sets the connection's displayed name.
  169.  *
  170.  * @param gc   The connection.
  171.  * @param name The displayed name.
  172.  */
  173. void purple_connection_set_display_name(PurpleConnection *gc, const char *name);
  174.  
  175. /**
  176.  * Returns the connection state.
  177.  *
  178.  * @param gc The connection.
  179.  *
  180.  * @return The connection state.
  181.  */
  182. PurpleConnectionState purple_connection_get_state(const PurpleConnection *gc);
  183.  
  184. /**
  185.  * Returns TRUE if the account is connected, otherwise returns FALSE.
  186.  *
  187.  * @return TRUE if the account is connected, otherwise returns FALSE.
  188.  */
  189. #define PURPLE_CONNECTION_IS_CONNECTED(gc) \
  190.     (gc->state == PURPLE_CONNECTED)
  191.  
  192. /**
  193.  * Returns the connection's account.
  194.  *
  195.  * @param gc The connection.
  196.  *
  197.  * @return The connection's account.
  198.  */
  199. PurpleAccount *purple_connection_get_account(const PurpleConnection *gc);
  200.  
  201. /**
  202.  * Returns the connection's password.
  203.  *
  204.  * @param gc The connection.
  205.  *
  206.  * @return The connection's password.
  207.  */
  208. const char *purple_connection_get_password(const PurpleConnection *gc);
  209.  
  210. /**
  211.  * Returns the connection's displayed name.
  212.  *
  213.  * @param gc The connection.
  214.  *
  215.  * @return The connection's displayed name.
  216.  */
  217. const char *purple_connection_get_display_name(const PurpleConnection *gc);
  218.  
  219. /**
  220.  * Updates the connection progress.
  221.  *
  222.  * @param gc    The connection.
  223.  * @param text  Information on the current step.
  224.  * @param step  The current step.
  225.  * @param count The total number of steps.
  226.  */
  227. void purple_connection_update_progress(PurpleConnection *gc, const char *text,
  228.                                      size_t step, size_t count);
  229.  
  230. /**
  231.  * Displays a connection-specific notice.
  232.  *
  233.  * @param gc   The connection.
  234.  * @param text The notice text.
  235.  */
  236. void purple_connection_notice(PurpleConnection *gc, const char *text);
  237.  
  238. /**
  239.  * Closes a connection with an error.
  240.  *
  241.  * @param gc     The connection.
  242.  * @param reason The error text.
  243.  */
  244. void purple_connection_error(PurpleConnection *gc, const char *reason);
  245.  
  246. /*@}*/
  247.  
  248. /**************************************************************************/
  249. /** @name Connections API                                                 */
  250. /**************************************************************************/
  251. /*@{*/
  252.  
  253. /**
  254.  * Disconnects from all connections.
  255.  */
  256. void purple_connections_disconnect_all(void);
  257.  
  258. /**
  259.  * Returns a list of all active connections.  This does not
  260.  * include connections that are in the process of connecting.
  261.  *
  262.  * @return A list of all active connections.
  263.  */
  264. GList *purple_connections_get_all(void);
  265.  
  266. /**
  267.  * Returns a list of all connections in the process of connecting.
  268.  *
  269.  * @return A list of connecting connections.
  270.  */
  271. GList *purple_connections_get_connecting(void);
  272.  
  273. /**
  274.  * Checks if gc is still a valid pointer to a gc.
  275.  *
  276.  * @return @c TRUE if gc is valid.
  277.  */
  278. /*
  279.  * TODO: Eventually this bad boy will be removed, because it is
  280.  *       a gross fix for a crashy problem.
  281.  */
  282. #define PURPLE_CONNECTION_IS_VALID(gc) (g_list_find(purple_connections_get_all(), (gc)))
  283.  
  284. /*@}*/
  285.  
  286. /**************************************************************************/
  287. /** @name UI Registration Functions                                       */
  288. /**************************************************************************/
  289. /*@{*/
  290.  
  291. /**
  292.  * Sets the UI operations structure to be used for connections.
  293.  *
  294.  * @param ops The UI operations structure.
  295.  */
  296. void purple_connections_set_ui_ops(PurpleConnectionUiOps *ops);
  297.  
  298. /**
  299.  * Returns the UI operations structure used for connections.
  300.  *
  301.  * @return The UI operations structure in use.
  302.  */
  303. PurpleConnectionUiOps *purple_connections_get_ui_ops(void);
  304.  
  305. /*@}*/
  306.  
  307. /**************************************************************************/
  308. /** @name Connections Subsystem                                           */
  309. /**************************************************************************/
  310. /*@{*/
  311.  
  312. /**
  313.  * Initializes the connections subsystem.
  314.  */
  315. void purple_connections_init(void);
  316.  
  317. /**
  318.  * Uninitializes the connections subsystem.
  319.  */
  320. void purple_connections_uninit(void);
  321.  
  322. /**
  323.  * Returns the handle to the connections subsystem.
  324.  *
  325.  * @return The connections subsystem handle.
  326.  */
  327. void *purple_connections_get_handle(void);
  328.  
  329. /*@}*/
  330.  
  331.  
  332. #ifdef __cplusplus
  333. }
  334. #endif
  335.  
  336. #endif /* _PURPLE_CONNECTION_H_ */
  337.